instant3Dhub Interfaces

instant3Dhub

Topics | Classes | Functions

instant3Dhub Interfaces

Detailed Description

General instant3Dhub functionality grouped by feature.

Topics
	ClipPlane API
	Material API
	Drawing API
	InstanceGraph API
	Selection API
	Snapshot API
	Space API

Classes
class	AI3DHConnector
class	FI3DHConnectorAPI

Functions
TSharedPtr< FI3DHConnectorAPI >	AI3DHConnector::GetAPI () const
virtual class AI3DHConnector *	FI3DHConnectorAPI::GetConnector ()=0
virtual FI3DHClipPlaneAPI *	FI3DHConnectorAPI::GetClipPlaneAPI ()=0
virtual FI3DHDrawingAPI *	FI3DHConnectorAPI::GetDrawingAPI ()=0
virtual FI3DHMaterialAPI *	FI3DHConnectorAPI::GetMaterialAPI ()=0
virtual FI3DHInstanceGraphAPI *	FI3DHConnectorAPI::GetInstanceGraphAPI ()=0
virtual FI3DHSelectionAPI *	FI3DHConnectorAPI::GetSelectionAPI ()=0
virtual FI3DHSnapshotAPI *	FI3DHConnectorAPI::GetSnapshotAPI ()=0
virtual FI3DHSpaceAPI *	FI3DHConnectorAPI::GetSpaceAPI ()=0

Function Documentation

◆ GetAPI()

TSharedPtr< FI3DHConnectorAPI > AI3DHConnector::GetAPI

(

)

const

Returns a shared pointer to the ConnectorAPI.

Using shared pointer semantics, the ConnectorAPI can be kept alive through asynchronous operations, etc. If you need to access the connector again from the ConnectorAPI see FI3DHConnectorAPI::GetConnector().

Returns

A shared pointer to the ConnectorAPI.

◆ GetClipPlaneAPI()

virtual FI3DHClipPlaneAPI * FI3DHConnectorAPI::GetClipPlaneAPI ( )

pure virtual

Gets clip plane API.

Returns

Returns pointer to the ClipPlaneAPI. Never nullptr.

◆ GetConnector()

virtual class AI3DHConnector * FI3DHConnectorAPI::GetConnector ( )

pure virtual

Gets the connector actor belonging to this API.

It's only useful to call this on the game thread. May return nullptr if the actor has already been destroyed.

Returns

Nullptr if it fails, else the connector.

◆ GetDrawingAPI()

virtual FI3DHDrawingAPI * FI3DHConnectorAPI::GetDrawingAPI ( )

pure virtual

Gets drawing API.

Returns

Returns pointer to the DrawingAPI. Never nullptr.

◆ GetInstanceGraphAPI()

virtual FI3DHInstanceGraphAPI * FI3DHConnectorAPI::GetInstanceGraphAPI ( )

pure virtual

Gets instance graph API.

Returns

Returns pointer to the InstanceGraphAPI. Never nullptr.

◆ GetMaterialAPI()

virtual FI3DHMaterialAPI * FI3DHConnectorAPI::GetMaterialAPI ( )

pure virtual

Gets material API.

Returns

Returns pointer to the MaterialAPI, or nullptr if this connector implementation does not provide it yet.

Experimental

The instant3Dhub Material API is experimental and under active development.

Experimental

Introduced in v1.4.0. "The instant3Dhub Material API is experimental and under active development."
This API is experimental. As such, there is no guarantee that it won't change or be removed in future releases. Please use at your own risk.

◆ GetSelectionAPI()

virtual FI3DHSelectionAPI * FI3DHConnectorAPI::GetSelectionAPI ( )

pure virtual

Gets selection API.

Returns

Returns pointer to the SelectionAPI. Never nullptr.

◆ GetSnapshotAPI()

virtual FI3DHSnapshotAPI * FI3DHConnectorAPI::GetSnapshotAPI ( )

pure virtual

Gets snapshot API.

Returns

Returns pointer to the SnapshotAPI. Never nullptr.

◆ GetSpaceAPI()

virtual FI3DHSpaceAPI * FI3DHConnectorAPI::GetSpaceAPI ( )

pure virtual

Gets Space API.

Returns

Returns pointer to the SpaceAPI. Never nullptr.

Experimental

The instant3Dhub Space API is experimental and under active development.

Experimental

Introduced in v1.4.0. "The instant3Dhub Space API is experimental and under active development."
This API is experimental. As such, there is no guarantee that it won't change or be removed in future releases. Please use at your own risk.

---

Generated by  1.14.0